/*
 * Copyright (c) 2023-2024 elsfs Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.elsfs.cloud.common.mybatis.context;

import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import org.apache.ibatis.annotations.Param;
import org.elsfs.cloud.common.mybatis.ext.mybatis.extension.JoinQueryWrapper;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;

/**
 * 自定义mapper
 *
 * @param <T> 实体类型
 */
public interface ELsfsBaseMapper<T> extends BaseMapper<T> {
  /**
   * 根据 entity 条件，查询全部记录 忽略软删除
   *
   * @param queryWrapper 实体对象封装操作类（可以为 null）
   */
  List<T> selectListIgnoreLogicDelete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

  /**
   * 根据 entity 条件，查询全部记录（并翻页） 忽略软删除
   *
   * @param page 分页查询条件
   * @param queryWrapper 实体对象封装操作类（可以为 null）
   * @since 3.5.3.2
   */
  List<T> selectListIgnoreLogicDelete(
      IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

  /**
   * 根据 entity 条件，查询全部记录（并翻页）
   *
   * @param page 分页查询条件
   * @param queryWrapper 实体对象封装操作类（可以为 null）
   */
  default <P extends IPage<T>> P selectPageIgnoreLogicDelete(
      P page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
    List<T> list = selectListIgnoreLogicDelete(page, queryWrapper);
    page.setRecords(list);
    return page;
  }

  /**
   * 根据 id 删除 忽略软删除
   *
   * @param id id
   * @return int
   */
  int deleteByIdIgnoreLogicDelete(Serializable id);

  /**
   * 根据 id 删除 忽略软删除
   *
   * @param entity 实体对象
   * @return int
   */
  int deleteByIdIgnoreLogicDelete(T entity);

  /**
   * 根据 id 批量删除 忽略软删除
   *
   * @param idList ids
   * @return int
   */
  int deleteBatchByIdIgnoreLogicDelete(@Param(Constants.COLL) Collection<?> idList);

  /**
   * 根据 id 恢复
   *
   * @param id id
   * @return int
   */
  int restoreById(Serializable id);

  /**
   * \* 根据 id 批量恢复
   *
   * @param idList ids
   * @return int
   */
  int restoreBatchById(@Param(Constants.COLL) Collection<?> idList);


  /**
   * 总是更新一些列的字段
   *
   * @param entity 实体对象
   * @return 影响行数
   */
  int alwaysUpdateSomeColumnById(T entity);

  /**
   * 批量插入指定行数的数据
   *
   * @param entities 实体对象列表
   * @return 影响行数
   */
  int insertBatchSomeColumn(Collection<T> entities);

  /**
   * 根据ID判断是否存在
   *
   * @param id 主键ID
   * @return bool 是否存在
   */
  Boolean existsById(String id);

  /**
   * 根据构建条件判断是否存在记录
   *
   * @param queryWrapper 查询条件构造器
   * @return bool 是否存在
   */
  Boolean existsByWrapper(@Param(Constants.WRAPPER) JoinQueryWrapper<T> queryWrapper);

  /**
   * 根据构建JOIN条件判断是否存在记录
   *
   * @param joinQueryWrapper JOIN查询条件构造器
   * @return bool 是否存在
   */
  Boolean existsByJoinWrapper(@Param(Constants.WRAPPER) JoinQueryWrapper<T> joinQueryWrapper);

  /**
   * 根据 Wrapper 条件，查询总记录数
   *
   * @param joinQueryWrapper 实体对象封装操作类（可以为 null）
   * @return 数量
   */
  Long selectJoinCount(@Param(Constants.WRAPPER) JoinQueryWrapper<T> joinQueryWrapper);

  /**
   * 根据 entity 条件，查询全部记录
   *
   * @param joinQueryWrapper 实体对象封装操作类（可以为 null）
   * @return 实体对象
   */
  T selectJoinOne(@Param(Constants.WRAPPER) JoinQueryWrapper<T> joinQueryWrapper);

  /**
   * 根据 entity 条件，查询全部记录
   *
   * @param joinQueryWrapper 实体对象封装操作类（可以为 null）
   * @return 实体记录列表
   */
  List<T> selectJoinList(@Param(Constants.WRAPPER) JoinQueryWrapper<T> joinQueryWrapper);

  /**
   * 根据 entity 条件，查询全部记录（并翻页）
   *
   * @param page             分页查询条件（可以为 RowBounds.DEFAULT）
   * @param joinQueryWrapper 实体对象封装操作类（可以为 null）
   * @param <P>              分页对象类型
   * @return 分页数据
   */
  <P extends IPage<T>> P selectJoinPage(P page, @Param(Constants.WRAPPER) JoinQueryWrapper<T> joinQueryWrapper);

}
